API Documentation
Script.h
1 // Script.h
3 //
5 
6 namespace nkScripts
7 {
13  class DLL_SCRIPTS_EXPORT Script final : public nkExport::Exportable
14  {
15  public :
16 
20  Script () ;
24  ~Script () ;
25 
26  // Getters
34  std::string_view getName () const ;
38  std::string_view getSources () const ;
43 
44  // Setters
50  void setScriptFor (INTERPRETER interpretType) ;
58  void setName (const std::string_view& name) ;
64  void setSources (const std::string_view& sources) ;
65 
71  bool load () ;
75  void unload () ;
76 
82  virtual void exportClassToTree (nkExport::Node* rootNode) override ;
88  virtual void importClassFromTree (nkExport::Node* rootNode) override ;
89  } ;
90 }
nkScripts::Script::setScriptFor
void setScriptFor(INTERPRETER interpretType)
nkScripts::Script::setSources
void setSources(const std::string_view &sources)
nkScripts
Encompasses all API of component NilkinsScripts.
Definition: Environment.h:7
nkScripts::Script
Holds all information for a script.
Definition: Script.h:14
nkExport::Exportable
An interface to define objects that can be exported using this component.
Definition: Exportable.h:15
nkScripts::Script::getName
std::string_view getName() const
nkScripts::Script::getScriptType
INTERPRETER getScriptType() const
nkScripts::Script::importClassFromTree
virtual void importClassFromTree(nkExport::Node *rootNode) override
nkScripts::Script::getLastCompilationResult
const CompilationResult & getLastCompilationResult() const
nkExport::Node
A node in the tree structure representing the data to export / import.
Definition: Node.h:42
nkScripts::Script::unload
void unload()
nkScripts::Script::~Script
~Script()
nkScripts::CompilationResult
Holds information about script loading attempt.
Definition: CompilationResult.h:24
nkScripts::Script::setName
void setName(const std::string_view &name)
nkScripts::INTERPRETER
INTERPRETER
Supported scripting environments.
Definition: Interpreter.h:12
nkScripts::Script::Script
Script()
nkScripts::Script::getSources
std::string_view getSources() const
nkScripts::Script::exportClassToTree
virtual void exportClassToTree(nkExport::Node *rootNode) override
nkScripts::Script::load
bool load()